home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / fdh60.zip / FDH60.DOC < prev    next >
Text File  |  1992-06-28  |  17KB  |  431 lines

  1.  
  2.  ┌───────────┬────────────────────────────────────────────────────┬───────────┐
  3.  │ ▄▀▄▀▄▀▄▀▄ │ NO NONSENSE BBS - Westfield - NJ    (908) 654-3178 │ ▄▀▄▀▄▀▄▀▄ │
  4.  │ ▄▀▄▀▄▀▄▀▄ ├────────────────────────────────────────────────────┤ ▄▀▄▀▄▀▄▀▄ │
  5.  │ ▄▀▄▀▄▀▄▀▄ │    FILE DIRECTORY HEADER Ver6.0 by Vince Rifici    │ ▄▀▄▀▄▀▄▀▄ │
  6.  │ ▄▀▄▀▄▀▄▀▄ ├─────────────┬─────────────────┬────────────────────┤ ▄▀▄▀▄▀▄▀▄ │
  7.  │ ▄▀▄▀▄▀▄▀▄ │ Files 1,021 │ K-Bytes  54,276 │ Updated 06-28-1992 │ ▄▀▄▀▄▀▄▀▄ │
  8.  └───────────┴─────────────┴─────────────────┴────────────────────┴───────────┘
  9.  
  10.                                   - 1 -
  11.  
  12.  
  13.         PCBoard 14.5a allows you to "break" the previous 79 column
  14.         restriction on DIRx text headers, so you can now add a nice
  15.         graphic header to your file directories.
  16.  
  17.         The possibilities are limitless!  This is one design I came up
  18.         with which not only looks sharp, but has the added feature of
  19.         displaying the date, number of files and number of bytes in each
  20.         directory.  All five header file colors are now configurable in
  21.         version 3.0.  Version 4.0 fixes the "out-of-string-space" error
  22.         experienced by some users when the size of a DIRx file exceeded
  23.         50k bytes.  Version 5.0 made minor corrections in the .DOC file.
  24.         Version 5.1 rounded the Bytes field to K-Bytes for easier
  25.         reading.  The Files & K-Bytes field is now in the image ##,###.
  26.         Total number of directories allowed has been increased from 100
  27.         to 150.  Version 6.0 corrects the "cut-off" header when using
  28.         PCBFILER to create an ALLFILES.LST.  Eliminates the hokie "VCR"
  29.         in the checkerboard design.
  30.  
  31.              EXECUTE THE FILE "SAMPLE1.EXE" TO SEE HOW THE
  32.                FINISHED PRODUCT WILL LOOK ON YOUR BOARD.
  33.  
  34.         Files contained in this archive are:
  35.  
  36.                 FDH60.EXE   <------------- The main executable program
  37.                 FDH60X.EXE  <------------- Alternate executable program
  38.                 FDH.CFG     <------------- Sample configuration file
  39.                 FDH51.DOC   <------------- Documentation file
  40.                 FDH.HST     <------------- Revision history
  41.                 SAMPLE1.TXT <------------- Sample of the new header
  42.                 SAMPLE2.TXT <------------- Sample directory file
  43.                 COLOR.CHT   <------------- PCB color code chart
  44.                 FILE_ID.DIZ <------------- Archive description
  45.  
  46.         The program was run and tested on only one PC (my own).  It is
  47.         an AT&T 6386 WGS running at 20mhz with 2 Megs of RAM memory.
  48.         DOS5.0 is installed as the operating system. It was written in
  49.         GWBASIC and was compiled using MicroSoft's QuickBASIC Compiler
  50.         Version 4.0.  It takes approx. 40 seconds to run to completion
  51.         on my BBS, which contains 51 directories and over 5,000 Files.
  52.  
  53.         It works flawlessly on my machine, but I cannot be responsible
  54.         for any problems you may have with it running on your machine.
  55.         Please be cautious!  Make backups of your file directories
  56.         before using it the first time!
  57.  
  58.  
  59.  
  60.  
  61.                                 - 2 -
  62.  
  63.  
  64.  
  65.         The limitations of the program are as follows:
  66.  
  67.                 Maximum number of file directories = 150
  68.                 Minimum free RAM of low memory needed = 64k
  69.                 Commas cannot be used in the directory titles
  70.  
  71.     The version of PCBoard I designed FDH for is 14.5a/D (single-
  72.         node).  I have absolutely no idea what would happen if it were
  73.         run on a multi-node version while callers were active on the
  74.         other nodes.  Suffice it to say, all nodes should be down when
  75.         this program is run.  That way, there is sure to be no problems.
  76.  
  77.         This program utilizes the PCBoard "@X" color codes to display
  78.         both color and monochrome with PCBoard Version 14.5a.  Read the
  79.         file COLOR.CHT for a complete list of "non-blinking" color codes
  80.         which may be used on PCBoard 14.5a.
  81.  
  82.  
  83.  
  84.  
  85.         Before running the program the following conditions MUST be met:
  86.  
  87.         1. FDH60.EXE and FDH.CFG must be located in the same sub-directory.
  88.            They can be located anywhere on your disk (even on a different
  89.            drive than your PCB files).
  90.  
  91.         2. All your file directories must be named DIRx, and must be
  92.            located in the same sub-directory (usually \PCB\GEN\).
  93.                Example:  DIR1, DIR2, ..., DIR150
  94.                             - not -
  95.                          DIR01, DIR02, ..., DIR150
  96.                (see exception on page 5) 
  97.  
  98.         3. You will have to create your own FDH.CFG file, or edit the
  99.            sample .CFG file included in the archive.  The filename must
  100.            remain FDH.CFG (it is hardcoded in the executable).
  101.  
  102.         4. The clock on your PC must be correct.  The date shown in the
  103.            header is generated internally.
  104.  
  105.  
  106.  
  107.  
  108.                                   - 3 -
  109.  
  110.  
  111.  
  112.         CREATING THE FDH.CFG FILE
  113.  
  114.         Use any pure ASCII text editor to create the FDH.CFG file.
  115.         The size of this file will vary depending on the number of
  116.         file directories you have.  If your board's directory structure
  117.         ever changes, you can re-edit the .CFG file and the program will
  118.         still work.  All configurable items are contained in this file.
  119.  
  120.  
  121.         The FIRST LINE is simply the number of DIRx file directories
  122.         for which you are configuring headers.
  123.  
  124.  
  125.         The SUBSEQUENT LINES contain the titles of all your DIRx file
  126.         directories.  Use one title per line, in sequential order.
  127.         End all lines with a simple carriage return & line feed.
  128.  
  129.  
  130.         The NEXT THREE LINES are as follows:
  131.  
  132.                 The complete path of your DIRx files
  133.                 (path only, no filename.  Place "\" at end of path)
  134.  
  135.                 The name and location of your BBS
  136.                 (this line should be no longer than 34 characters)
  137.  
  138.                 Your BBS telephone number  (maximum 14 characters)
  139.  
  140.  
  141.         The LAST FIVE LINES are the PCB "@X" color codes for configuring
  142.         the header colors.  See the file COLOR.CHT for all the available
  143.         colors you can use.  Be sure to enter these codes in CAPS!
  144.  
  145.                 Color of the Border Lines
  146.                 Color of the Checkerboard Flag
  147.                 Color of your BBS Name and Tel No.
  148.                 Color of all the Variable Information
  149.                 Color of all Fixed Titles
  150.  
  151.  
  152.       * IMPORTANT:  DO NOT USE COMMAS ANYWHERE IN THE FDH.CFG FILE!
  153.  
  154.                     THE NUMBER OF DIRECTORY TITLES MUST BE EQUAL TO
  155.                     THE NUMBER SHOWN ON THE FIRST LINE IN FDH.CFG!
  156.  
  157.  
  158.  
  159.  
  160.                                  - 4 -
  161.  
  162.  
  163.  
  164.  
  165.         Here is a sample illustration of a FDH.CFG file containing
  166.         five file directories:
  167.  
  168.         5                          <------- cannot be higher than 150
  169.         DOS Utilities & Shells     <------- maximum 36 characters
  170.         Communication Programs                      "
  171.         File Transfer Protocols                     "
  172.         BBS System Software                         "
  173.         Sysop & User Utilities                      "
  174.         E:\PCB\GEN\                     <---- may be any length
  175.         NO NONSENSE - Westfield - NJ    <---- maximum 34 characters
  176.         (908) 654-3178                  <---- maximum 14 characters
  177.         @X09   <-------- Bright blue Border Lines
  178.         @X0C   <-------- Bright red Checkerboard Flag
  179.         @X0B   <-------- Bright cyan BBS Name & Tel No.
  180.         @X0A   <-------- Bright green Descriptions & File Counts
  181.         @X03   <-------- Standard cyan Fixed Titles
  182.  
  183.         All lines are ended with a simple carriage return & line feed.
  184.         Do not use any blank spaces before or after the information on
  185.         any line.
  186.  
  187.  
  188.  
  189.         PREPARING YOUR FILE DIRECTORIES
  190.  
  191.         Each of your DIRx file directories should contain only one
  192.         header line.  This is the PCB 14.5a statement which calls up the
  193.         header file when it's displayed on the board.
  194.  
  195.         Place the following statement on the first line in each of your
  196.         DIRx directories:
  197.  
  198.         %E:\PCB\GEN\DIRx.HED  <--- use the same path as your DIRx files
  199.                                    (you MUST use .HED for the extension) 
  200.  
  201.         This line begins with a percent (%) sign and contains the path
  202.         and file name of the header files.
  203.  
  204.         The header files are automatically created when the program
  205.         FDH60.EXE is executed.  The files are named DIRx.HED and are
  206.         created in the same directory as your DIRx files.
  207.  
  208.         See SAMPLE2.TXT for a sample of my directory #1 (DIR1).
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.                                     - 5-
  216.  
  217.  
  218.  
  219.         VERSITILITY OF THE PROGRAM
  220.  
  221.         The preceding set-up for configuring the .CFG file applies to all
  222.         conferences which use the same DIRx files.  Sometimes a conference
  223.         may use different DIRx files.  In this case, you would configure
  224.         a separate FDH.CFG tailored specifically for that conference.  Be
  225.         sure to specify the correct path to the directory which contains
  226.         the different conference DIRx files.
  227.  
  228.  
  229.         Let's suppose your Sysops Conference directories are named "SDIRx"
  230.         instead of "DIRx".  When you specify the path of the "SDIRx" files
  231.         in the .CFG file, just enter, for instance:
  232.  
  233.                      E:\PCB\SYSOPS\S
  234.         instead of,
  235.                      E:\PCB\GEN\
  236.  
  237.         If you include the first letter of the "SDIRx" files in the path,
  238.         it will then find all the Directories which begin with "S", and will
  239.         create all the header files with the name of "SDIRx.HED" instead of
  240.         "DIRx.HED".  Simple, huh!
  241.  
  242.         NOTE:  If your public upload directory is named "UP or UPLOAD",
  243.                sorry, you are out-of-luck!  Either change the name of your
  244.                upload directory, or be satisfied that no header will be
  245.                created for it.
  246.  
  247.         Don't forget to change the calling statement on the first line of
  248.         your Sysops directories to:  %E:\PCB\SYSOPS\SDIRx.HED (or whatever
  249.         path applies).
  250.  
  251.  
  252.         FDH is idealy suited to be run in your EVENT.SYS as a daily
  253.         event.  Shown below are the statements which will allow you to
  254.         run one or more copies of FDH in your event:
  255.  
  256.                 E:            <---- drive specifier
  257.                 CD\PCB\GEN    <---- cd to dir containing FDH50.EXE & FDH.CFG
  258.                 FDH60.EXE     <---- the .EXE program
  259.                 CD\PCB\ADULTS
  260.                 FDH60.EXE
  261.                 CD\PCB\SYSOPS
  262.                 FDH60.EXE
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.                                   - 6 -
  270.  
  271.  
  272.  
  273.         A MINOR CONFLICT (Left to your discretion)
  274.  
  275.         FDH60 (and all previous versions) does not place a blank line
  276.         between the header and the first entry in the DIR file when
  277.         viewed on-line.  I did this purposly to provide a nicer appearance
  278.         to the caller.
  279.  
  280.  
  281.         It has, however, caused a problem when you use PCBFILER to create
  282.         your ALLFILES.LST.  The last line of the header is cut off!
  283.  
  284.         I can see no easy way around this problem except to re-insert the
  285.         blank line at the end of the header graphic.  Therefore, I have
  286.         provided two FDH executable files in version 6.0 archive.
  287.  
  288.         1.  FDH60.EXE - does NOT provide a blank line (for those who DO NOT
  289.                         use PCBFILLER to make the ALLFILES.LST.)
  290.  
  291.         2.  FDH60X.EXE - Provides a blank line to prevent the cut-off
  292.                          header in ALLFILES.LST when you use PCBFILER.
  293.  
  294.  
  295.         You can use whichever one suits your purpose.  Idealy, you could
  296.         run FDH60X.EXE before you make your ALLFILES.LST.  Then run
  297.         FDH60.EXE after the list is made, to eliminate the blank line
  298.         to your callers.
  299.  
  300.         I personally run both in my daily event because I'm asleep and the
  301.         extra time it takes doesn't matter.  It only adds an extra 2-3
  302.         minutes to the event.
  303.  
  304.         If anyone has a better solution to solving this problem, I would
  305.         appreciate hearing from you.  Thanks.
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.                                      - 7 -
  313.  
  314.  
  315.  
  316.         GET READY TO "GO"
  317.  
  318.         After you have built your FDH.CFG file, and configured all
  319.         your DIRx files to add the PCB 14.5a calling statement, you are
  320.         ready to run FDH60.EXE.
  321.  
  322.         Please take my advice and backup all your DIRx files before
  323.         running this program for the first time.  It really should not
  324.         do any damage to the DIRx files, even if you make mistakes in
  325.         building the .CFG file.  The program merely opens the DIRx's to
  326.         count the files and the bytes and does not modify them in any
  327.         way.  If you do "mess up", just correct the errors in the .CFG
  328.         file and run the program again.  Each time the program is run,
  329.         it overwrites the old .HED files and builds completely new ones.
  330.  
  331.  
  332.  
  333.         UPGRADING FROM PREVIOUS VERSIONS
  334.  
  335.         If you are upgrading from version 1.0, make the following
  336.         changes:
  337.  
  338.         1.  Replace the file FDH10.EXE with FDH60.EXE.
  339.  
  340.         2.  Delete the file FDH10.MSK.  It is no longer needed.
  341.  
  342.         3.  Change the name of FDH10.DAT to FDH.CFG and add the last
  343.             five color code lines to the end of the file.  (See the
  344.             sample .CFG file on page 4)
  345.  
  346.         
  347.         To upgrade from any other version except 1.0, just replace the
  348.         FDH executable file with the new one.
  349.  
  350.  
  351.  
  352.  
  353.  
  354.                                  - 8 -
  355.  
  356.          
  357.         TROUBLE SHOOTING
  358.  
  359.  
  360.         The first place to look for possible trouble is in the FDH.CFG file.
  361.  
  362.         1.  Count your directory titles and make sure it is equal to the
  363.             number specified on the first line.
  364.  
  365.         2.  Make sure you have NOT used commas (or colons) in any of the
  366.             directory titles.
  367.  
  368.         3.  Make sure you have NOT placed any leading or trailing spaces
  369.             on any of the lines.
  370.  
  371.         4.  Examine the ASCII editor you used to build or edit the FDH.CFG
  372.             file.  It must be a pure DOS ASCII editor such as QEdit or the
  373.             built in DOS5.0 text editor.  Every line must end with a simple
  374.             carrage return and line feed.
  375.  
  376.         5.  Make sure you are using the correct format for the PCB "@X"         
  377.             color codes.  They must be in upper case.  A common mistake is
  378.             to use the letter "O" instead of the number "0".
  379.  
  380.         6.  Make sure the path to your DIR files ends with a "\".
  381.             (An exception to this is shown on Page 5, paragraph 2)
  382.  
  383.         7.  If your problem is incorrect ANSI colors, change the PCB "@X"
  384.             color codes to "@X07" (pure mono).  Then re-run FDH60.EXE again.
  385.             It could be that a non-standard version of ANSI.SYS is loaded
  386.             in your CONFIG.SYS file.  I have no way of testing this!
  387.  
  388.  
  389.                              - END OF DOCS -
  390.  
  391.  
  392.  
  393.  
  394.  
  395.                                   - 9 -
  396.  
  397.  
  398.  
  399.  
  400.              The latest copy of FDH is always available on:
  401.  
  402.                             NO NONSENSE BBS
  403.                              Westfield, NJ
  404.                             (908) 654-3178
  405.  
  406.        If you find this program useful please send a small donation to:
  407.  
  408.                            Vincent C. Rifici 
  409.                           433 Mountain Avenue
  410.                           Westfield, NJ 07090
  411.  
  412.         FDH is not "crippled" in any way.
  413.  
  414.  
  415.  
  416.         My thanks to Neil Stewart, E.I.B. BBS, Hillsdale, NJ for first
  417.         testing the program and reporting the "bugs" which got by me on
  418.         the initial writing.
  419.  
  420.         Thanks to:  John Meyer, AFTER THE STORM BBS, Rahway, NJ
  421.                     Matt Korybsky, JUST PROGRAMS BBS, Roselle Pk, NJ
  422.                     Chris Sloyan, THE ARENA BBS, Kenilworth, NJ
  423.         for further testing the program, and suggesting some changes
  424.         which greatly improved it's versatility.
  425.  
  426.         Thanks to Clark Development Company for providing all the "nice"
  427.         little features in PCBoard 14.5a which made this program possible.
  428.  
  429.  
  430.  
  431.